WirelessClientProcess handles and manipulates wireless clients. More...
Inheritance diagram for WirelessClientProcess:
Public Member Functions | |
| bool | addProfile (string, string, WirelessNetworkType, mac, WirelessAuthenType, WirelessEncryptType, string, string, string, bool, bool, ip, ip, ip, ip) |
| Adds a wireless profile. More... | |
| bool | deleteProfile (string) |
| Deletes the wireless profile with the specified name. More... | |
| WirelessProfile | getProfile (string) |
| Returns the wireless profile with the specified name. More... | |
| int | getProfileCount () |
| Returns the number of wireless profiles. More... | |
| WirelessProfile | getProfileAt (int) |
| Returns the wireless profile at the specified index. More... | |
| WirelessProfile | getCurrentProfile () |
| Returns the current wireless profile. More... | |
| bool | setCurrentProfile (string, string, WirelessNetworkType, mac, WirelessAuthenType, WirelessEncryptType, string, string, string, bool, bool, ip, ip, ip, ip) |
| Sets the current wireless profile with the specified settings. More... | |
| bool | setCurrentProfileStringIPs (string, string, WirelessNetworkType, string, WirelessAuthenType, WirelessEncryptType, string, string, string, bool, bool, string, string, string, string) |
| int | getCurrentNetworkCount () |
| Returns the number of current network wireless profiles. More... | |
| WirelessProfile | getCurrentNetworkAt (int) |
| Returns the current network wireless profile at the specified index. More... | |
| mac | getCurrentApMac () |
| Returns the MAC address of the current access point. More... | |
 Public Member Functions inherited from WirelessCommon | |
| WirelessAuthenType | getAuthenType () |
| Returns the authentication type. More... | |
| void | setAuthenType (WirelessAuthenType) |
| void | setSsid (string) |
| Sets the SSID. More... | |
| string | getSsid () |
| Returns the SSID. More... | |
| WirelessNetworkType | getNetworkType () |
| Returns the network type. More... | |
| void | setNetworkType (WirelessNetworkType) |
| bool | setPort (string) |
| Sets the wireless port with the specified port. More... | |
| Port | getPort () |
| Returns the wireless port. More... | |
| WEPProcess | getWepProcess () |
| Returns the WEP process. More... | |
| void | resetAllAssociations () |
| Resets all wireless associations. More... | |
| WirelessEncryptType | getEncryptType () |
| Get encryption type. More... | |
| void | setEncryptType (WirelessEncryptType) |
| Set encryption type \para type, enum<WirelessEncryptType> eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, //Arun wpa eEncryptAES = 4. More... | |
| void | setStandardChannel (StandardChannel) |
| Set standard channel \para type, enum<StandardChannel> eStandardChannel_1 = 0, // channel: 1 - 2.412GHz eStandardChannel_2 = 1, // channel: 2 - 2.417GHz eStandardChannel_3 = 2, // channel: 3 - 2.422GHz eStandardChannel_4 = 3, // channel: 4 - 2.427GHz eStandardChannel_5 = 4, // channel: 5 - 2.432GHz eStandardChannel_6 = 5, // channel: 6 - 2.437GHz eStandardChannel_7 = 6, // channel: 7 - 2.442GHz eStandardChannel_8 = 7, // channel: 8 - 2.447GHz eStandardChannel_9 = 8, // channel: 9 - 2.452GHz eStandardChannel_10 = 9, // channel: 10 - 2.457GHz eStandardChannel_11 = 10 // channel: 11 - 2.462GHz. More... | |
| StandardChannel | getStandardChannel () |
| Get standard channel. More... | |
| void | setWideChannel (WideChannel) |
| Set wide channel. More... | |
| WideChannel | getWideChannel () |
| Get wide channel. More... | |
| WirelessRadioBand | getRadioBand () |
| Get radio band. More... | |
| void | setRadioBand (WirelessRadioBand) |
| Set radio band. More... | |
| WPAProcess | getWpaProcess () |
| Get Wpa Process. More... | |
| Public Member Functions inherited from Process | |
| Device | getOwnerDevice () |
| Returns the device for this process. More... | |
Detailed Description
WirelessClientProcess handles and manipulates wireless clients.
Member Function Documentation
◆ addProfile()
| bool WirelessClientProcess::addProfile | ( | string | , |
| string | , | ||
| WirelessNetworkType | , | ||
| mac | , | ||
| WirelessAuthenType | , | ||
| WirelessEncryptType | , | ||
| string | , | ||
| string | , | ||
| string | , | ||
| bool | , | ||
| bool | , | ||
| ip | , | ||
| ip | , | ||
| ip | , | ||
| ip | |||
| ) |
Adds a wireless profile.
- Parameters
-
name,the name for the wireless profile. ssid,the SSID of the access point. netType,the network type. Network types: eWirelessDisabled = 0x0, eWirelessB = 0x1, eWirelessG = 0x2, eWirelessBGMixed = 0x3, eWirelessN = 0x4, eWirelessA = 0x5, eWirelessMixed = 0x7 macAddress,the MAC address of the access point. authType,the authentication type. Authentication types: eAuthenNull = 0, eAuthenWep = 1, eAuthenWPA1_PSK = 2, eAuthenWPA1_EAP = 3, eAuthenWPA2_PSK = 4, eAuthenWPA2_EAP = 5, eAuthenOpen = 6 encryptType,the encryption type. Encryption types: eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, eEncryptAES = 4 wepKey,the WEP key. userid,the user ID for WPA enterprise. password,the password for WPA enterprise. bDHCPOn,true to enable DHCP, false to disable DHCP. bDHCPv6On,true to enable DHCPv6, false to disable DHCPv6. ipAddress,the IP address for the interface. subnet,the subnet mask for the interface. gateway,the default gateway for the interface. DNS,the DNS server for the interface.
- Returns
- bool, true if successful, otherwise false.
◆ deleteProfile()
| bool WirelessClientProcess::deleteProfile | ( | string | ) |
Deletes the wireless profile with the specified name.
- Parameters
-
name,the name of the wireless profile of interest.
- Returns
- bool, true if successful, otherwise false.
◆ getCurrentApMac()
| mac WirelessClientProcess::getCurrentApMac | ( | ) |
Returns the MAC address of the current access point.
- Returns
- mac, the MAC address of the current access point.
◆ getCurrentNetworkAt()
| WirelessProfile WirelessClientProcess::getCurrentNetworkAt | ( | int | ) |
Returns the current network wireless profile at the specified index.
- Parameters
-
index,the index of the current network wireless profile of interest.
- Returns
- WirelessProfile, the WirelessProfile object at the specified index.
◆ getCurrentNetworkCount()
| int WirelessClientProcess::getCurrentNetworkCount | ( | ) |
Returns the number of current network wireless profiles.
- Returns
- int, the number of current networks wireless profiles.
◆ getCurrentProfile()
| WirelessProfile WirelessClientProcess::getCurrentProfile | ( | ) |
Returns the current wireless profile.
- Returns
- WirelessProfile, the WirelessProfile object.
◆ getProfile()
| WirelessProfile WirelessClientProcess::getProfile | ( | string | ) |
Returns the wireless profile with the specified name.
- Parameters
-
name,the name of the wireless profile of interest.
- Returns
- WirelessProfile, the WirelessProfile object with the specified name.
◆ getProfileAt()
| WirelessProfile WirelessClientProcess::getProfileAt | ( | int | ) |
Returns the wireless profile at the specified index.
- Parameters
-
index,the index of the wireless profile of interest.
- Returns
- WirelessProfile, the WirelessProfile object at the specified index.
◆ getProfileCount()
| int WirelessClientProcess::getProfileCount | ( | ) |
Returns the number of wireless profiles.
- Returns
- int, the number of wireless profiles.
◆ setCurrentProfile()
| bool WirelessClientProcess::setCurrentProfile | ( | string | , |
| string | , | ||
| WirelessNetworkType | , | ||
| mac | , | ||
| WirelessAuthenType | , | ||
| WirelessEncryptType | , | ||
| string | , | ||
| string | , | ||
| string | , | ||
| bool | , | ||
| bool | , | ||
| ip | , | ||
| ip | , | ||
| ip | , | ||
| ip | |||
| ) |
Sets the current wireless profile with the specified settings.
- Parameters
-
name,the name for the wireless profile. ssid,the SSID of the access point. netType,the network type. Network types: eWirelessDisabled = 0x0, eWirelessB = 0x1, eWirelessG = 0x2, eWirelessBGMixed = 0x3, eWirelessN = 0x4, eWirelessA = 0x5, eWirelessMixed = 0x7 macAddress,the MAC address of the access point. authType,the authentication type. Authentication types: eAuthenNull = 0, eAuthenWep = 1, eAuthenWPA1_PSK = 2, eAuthenWPA1_EAP = 3, eAuthenWPA2_PSK = 4, eAuthenWPA2_EAP = 5, eAuthenOpen = 6 encryptType,the encryption type. Encryption types: eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, eEncryptAES = 4 wepKey,the WEP key. userid,the user ID for WPA enterprise. password,the password for WPA enterprise. bDHCPOn,true to enable DHCP, false to disable DHCP. bDHCPv6On,true to enable DHCPv6, false to disable DHCPv6. ipAddress,the IP address for the interface. subnet,the subnet mask for the interface. gateway,the default gateway for the interface. DNS,the DNS server for the interface.
- Returns
- bool, true if successful, otherwise false.
◆ setCurrentProfileStringIPs()
| bool WirelessClientProcess::setCurrentProfileStringIPs | ( | string | , |
| string | , | ||
| WirelessNetworkType | , | ||
| string | , | ||
| WirelessAuthenType | , | ||
| WirelessEncryptType | , | ||
| string | , | ||
| string | , | ||
| string | , | ||
| bool | , | ||
| bool | , | ||
| string | , | ||
| string | , | ||
| string | , | ||
| string | |||
| ) |
The documentation for this class was generated from the following file:
